AI SDK Kotlin/ai.torad.aisdk/StreamEvent/Finish

Finish

@Serializable

data class Finish(val totalSteps: Int, val finishReason: FinishReason, val usage: Usage, val providerMetadata: Map<String, JsonElement>? = null, val rawFinishReason: String? = null) : StreamEvent

Loop ended — final aggregated finish reason + usage.

Constructors

Finish

constructor(totalSteps: Int, finishReason: FinishReason, usage: Usage, providerMetadata: Map<String, JsonElement>? = null, rawFinishReason: String? = null)

Properties

finishReason

val finishReason: FinishReason

metadata

val StreamEvent.metadata: Map<String, JsonElement>?

providerMetadata

val providerMetadata: Map<String, JsonElement>?

Provider-specific summary payload on completion (per historical parity gap #18 slice). Routing layers measure end-to-end cache rate here without parsing each step.

rawFinishReason

val rawFinishReason: String?

The provider's OWN finish-reason string, before mapping. The mapped finishReason collapses unknown values to FinishReason.Other — but for diagnosing a provider-side abort the raw string is the evidence; never discard it.

totalSteps

val totalSteps: Int

usage

val usage: Usage

Functions

providerMetadataAs

inline fun <T> StreamEvent.providerMetadataAs(provider: String): T?

fun <T> StreamEvent.providerMetadataAs(provider: String, serializer: KSerializer<T>): T?